home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / utildos2.arc / FK20.DOC < prev    next >
Text File  |  2019-11-16  |  7KB  |  156 lines
  1.  
  2. **********************************************************************
  3.   DOCUMENTATION FOR FK : A FUNCTION KEY HANDLER FOR PC-DOS 1.0 and 1.1
  4. **********************************************************************
  5.  
  6. I.  Introduction
  7.  
  8.     This document describes the program FK, a function key handler for
  9. use under IBM PC-DOS versions 1.0 and 1.1.  The program may not work
  10. under other versions of DOS.
  11.  
  12.     This document is up-to-date as of Halloween 1982.
  13.  
  14.     The program was developed under a grant from Userview Corporation.
  15.  
  16.  
  17. II.  Rationale
  18.  
  19.     Under standard PC-DOS, the ten function keys are not used to their
  20. full potential.  The keys are used for simple command line editing, and
  21. several of the functions are duplicated by other keys on the keyboard.
  22. FK allows you to assign strings up to 24 characters in length to each
  23. of the function keys, so you can give an entire command or file name
  24. with a single keypress.
  25.  
  26.     For those who use the normal PC-DOS command line editing facilities,
  27. FK moves functions not already duplicated to keys on the cursor moving pad.
  28.  
  29.  
  30. III.  Using the program
  31.  
  32.     There are five different actions available with FK.  They all
  33. begin with the command name 'FK'; of course, the FK program (FK.COM) must be
  34. available on the selected disk drive when the command is issued.
  35.  
  36.     The actions are as follows:
  37.  
  38.     SHOWING THE DEFINITIONS:  You may display the current definitions
  39. of the ten function keys by giving the command "FK". Control characters
  40. imbedded in the strings are displayed as ^x (just as they are echoed
  41. during command line input) except for carriage return (ENTER), which is
  42. displayed as a vertical bar. Users with a printer may get
  43. a hardcopy of their definitions by pressing CTRL-PRTSC before giving the
  44. FK command.  Note that earlier versions of FK used a leftward-pointing
  45. arrow (ASCII 27) to show a carriage return; this was changed to a
  46. vertical bar for consistency with "FK Fn" (see below) and to avoid
  47. problems with printers which use ASCII 27 (ESC) as a special code.
  48.  
  49.     REDEFINING A KEY:  You may assign a string to one of the function
  50. keys by giving the command "FK Fn <string>" where n is the number of the
  51. key to assign (1 thru 10), and <string> is the string of characters you
  52. wish to get when you press that key.  For example, "FK F1 DIR" would
  53. assign the directory command "DIR" to function key F1.  You may include
  54. a carriage return in the string by using the vertical line character (|)
  55. wherever you want the CR; for example, "FK F1 DIR|" would do the directory
  56. command immediately upon your pressing F1 (in the previous case, you would
  57. have to press ENTER yourself after pressing F1).  Keys may only be assigned
  58. strings of up to 24 characters in length; strings which are too long will
  59. be truncated without warning.
  60.  
  61.     SAVING THE DEFINITIONS:  You may save the current definitions of
  62. the function keys to a disk file for later use (see LOADING below).  To
  63. do so, give the command "FK SAVE <fname>" where <fname> is the name of
  64. the file in which to save the definitions.  For example, "FK SAVE MY.KEY"
  65. would save all current key assignments in the file "MY.KEY".  Any valid
  66. filename may be used, but the use of the ".KEY" extension is recommended
  67. for clarity.
  68.  
  69.     LOADING KEY DEFINITIONS:  You may recover key definitions previously
  70. saved with "FK SAVE" by typing "FK LOAD <fname>", where <fname> is the
  71. name of the file containing the key definitions.  You should *only* use
  72. this command on files which have been created by "FK SAVE"; if you don't,
  73. FK will probably not accept the file.  The key definitions which are
  74. automatically loaded with FK when it is first called should be available
  75. in the file "STD.KEY" on the disk with this document.
  76.  
  77.     GETTING HELP: You can get a rundown of these command formats by
  78. typing "FK HELP".
  79.  
  80.  
  81.     FK, Quad Version
  82.  
  83.     The new version of FK supports definition of all four banks
  84. (normal, shifted, ALT, and CTRL) of the function keys.    An expanded
  85. version of the HELP message is available in the new FK.
  86.  
  87.  
  88. IV.  Notes
  89.  
  90.     Abbreviations: You can use S, L, and H as abbreviations for
  91. "SAVE", "LOAD", and "HELP", respectively.  For example, you might type
  92. "FK L STD.KEY" to recover those definitions.
  93.  
  94.     Warning concerning key files:  Attempting to load key files
  95. which were not created with "FK SAVE" or which were altered with DEBUG
  96. or some editor may result in system crashes.
  97.  
  98.     Command line editing facilities:  As mentioned, the old actions
  99. assigned to the function keys have been moved to the cursor keypad.
  100. F1 (copy one char from template) has always been duplicated by the cursor-
  101. right key.  With FK active, the skip/copy function of F2 is moved to
  102. the cursor-up key.  Copy-remaining (F3) is moved to the END key.
  103. Skip/delete (F4) is now assigned to the down-arrow key. Move-displayed (F5)
  104. has been reassigned to the BACKTAB (shift-tab) key. (NOTE: versions
  105. of FK before 8/27/82 used the HOME key for this purpose.)
  106.  
  107.     F6 was used by DOS to issue the end-of-file mark, ^Z.  The
  108. standard key definitions leave ^Z assigned to F6, but if you need to
  109. change this, you can always signal end-of-file by typing CTRL-Z.
  110.  
  111.  
  112. V. Additions to revision 2
  113.  
  114.     The following enhancements have been added to FK (version 08/27/82).
  115. Thanks to Webb Blackman, Jr. , and Michael Sullivan for suggestions and
  116. comments.
  117.  
  118.     * QUIET MODE: To prevent extraneous output during FK processing
  119.       (for example, the possibly unwanted listing of key definitions
  120.       during a "load" in an autoexec file), the 'quiet mode' option
  121.       has been added.  Preceeding any command letter with 'Q' causes
  122.       most output to be suppressed.  Copyright notices and error
  123.       messages will be displayed even if quiet mode is requested.
  124.       Example: "FK QL DEV.KEY" to 'quietly' load the definition file
  125.       "DEV.KEY".
  126.  
  127.     * WIDE DISPLAY:  Preceeding any command letter with 'W' causes
  128.       key definitions to be displayed two per line.  One can
  129.       also use "FK W" to simply display the keys in the wide format.
  130.  
  131.     * DEFAULT EXTENSION:  If no extension is supplied on loading
  132.       or saving keys, FK adds ".KEY" to the file name.
  133.  
  134.     * ONE-KEY SCREEN CLEAR: The HOME key now clears the screen and
  135.       issues a carriage return.  As mentioned above, previous versions
  136.       of FK had used HOME for the old F5 function; 08/27/82 FK uses
  137.       BACKTAB for this function.
  138.  
  139.     * EASIER PATCHING:  FK has been recoded to facilitate patching
  140.       to support nonstandard versions of DOS (i.e. RAMDrive, Davong,
  141.       JEL, etc). Patching methods are available in the document
  142.       FKPATCH.DOC.
  143.  
  144.     The author may be contacted at:
  145.  
  146.         Jeffrey P. Garbers
  147.         890E Clubhouse Circle West
  148.         Decatur, GA 30032
  149.  
  150.         or via SourceMail at CL0040
  151.  
  152.         or via the PC Midnight Express at 404-294-6879.
  153.  
  154.  
  155.  
  156.